/subscribers/{serviceNo}/balances
[GET]
This operation retrieves list of balances by using subscriber number.
URL
http://[host]:[port]/bot-ux/v1/{businessId}/subscribers/{serviceNo}/balances
URI Parameter
| Name | Type | Description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code ("PA","JM","TT","BB","BS","CW","LC","VC","AG") identifying the business unit. | M |
| serviceNo | number | Service number or subscriber number(for PA and CWC Bu's(Ex: "JM","TT","BB","BS","CW","LC","VC","AG")) | M |
| name | value | description | required |
|---|
| Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.</br>Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b </br> | M |
| lob | String | TheLine of Business Identifier currently available are:<br>Enum: PREPAID <br> | M |
| Name | Type | Description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | M |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | M |
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
PA Success Response for /v2 :
[
{
"id": "210",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement/v4/PA/bucket/66431202?logicalResourceId=66431202",
"isShared": true,
"description": "PROMOCIONAL PSB 210",
"name": "PROMOCIONAL",
"status": "Active",
"logicalResource": [
{
"@type": "MSISDN",
"id": "66431202"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "66431202"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "210",
"usageType": "monetary",
"remainingValue": {
"amount": 2.96,
"units": "USD"
},
"remainingValueName": "2.96 USD",
"validFor": {
"startDateTime": "2023-03-17T08:00:00.000-05:00",
"endDateTime": "2023-07-15T08:00:00.000-05:00"
},
"@language": "ENG"
},
{
"id": "1",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement/v4/PA/bucket/1?logicalResourceId=66431202",
"isShared": true,
"description": "MINUTOS GRATIS A MAS MOVIL",
"name": "dedicated",
"status": "Credit Expired",
"logicalResource": [
{
"@type": "MSISDN",
"id": "66431202"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "1"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "Bucket",
"usageType": "voice",
"remainingValue": {
"amount": 0,
"units": "min"
},
"remainingValueName": "0 min",
"validFor": {
"endDateTime": ""
},
"@language": "ENG"
}
]
PA Success Response for /v1 :
{
"id": "66431202",
"href": "https://esb-test.lla.com/cwp-paymentManagement-ux/v1/PA/bucket/66431202",
"description": "PROMOCIONAL PSB 210",
"name": "PROMOCIONAL",
"@type": 210,
"remainingValue": {
"amount": 2.96,
"units": "USD"
},
"usageType": "monetary",
"validFor": {
"startDateTime": "2023-03-17T08:00:00Z",
"endDateTime": "2023-07-15T08:00:00Z"
},
"bucketBalance": [
{
"id": 1,
"name": "dedicated",
"description": "MINUTOS GRATIS A MAS MOVIL",
"remainingValue": {
"amount": 0,
"units": "min"
},
"validFor": {
"endDateTime": ""
},
"@type": "Bucket"
},
{
"id": 4,
"name": "dedicated",
"description": "SALDO PROMOCIONAL",
"remainingValue": {
"amount": 120.0,
"units": "USD"
},
"validFor": {
"endDateTime": "2023-04-15T08:00:00Z"
},
"@type": "Bucket"
},
{
"id": 5,
"name": "dedicated",
"description": "MENSAJES DE TEXTO A MAS MOVIL",
"remainingValue": {
"amount": 2300,
"units": "SMS"
},
"validFor": {
"endDateTime": "2023-04-16T08:00:00Z"
},
"@type": "Bucket"
},
{
"id": 15,
"name": "dedicated",
"description": "MINUTOS A MAS MOVIL",
"remainingValue": {
"amount": 0,
"units": "min"
},
"validFor": {
"endDateTime": ""
},
"@type": "Bucket"
},
{
"id": 16,
"name": "dedicated",
"description": "MINUTOS A OTRAS REDES",
"remainingValue": {
"amount": 52,
"units": "min"
},
"validFor": {
"endDateTime": "2023-04-16T08:00:00Z"
},
"@type": "Bucket"
},
{
"id": 200,
"name": "dedicated",
"description": "MINUTOS A MAS MOVIL ILIMITADOS ",
"remainingValue": {
"amount": 1,
"units": "Unlimited"
},
"validFor": {
"endDateTime": "2023-04-16T08:00:00Z"
},
"@type": "Bucket"
},
{
"id": 1,
"name": "offer",
"description": "Plan de Data Full Smartphone",
"remainingValue": {
"amount": 40725,
"units": "Mb"
},
"remainingValueName": "Regular",
"validFor": {
"endDateTime": "2023-04-16T23:05:28Z"
},
"@type": "Bucket"
},
{
"id": 6,
"name": "offer",
"description": "Plan de Data Whatsapp",
"remainingValue": {
"amount": 12596,
"units": "Mb"
},
"remainingValueName": "Regular",
"validFor": {
"endDateTime": "2023-04-16T23:05:30Z"
},
"@type": "Bucket"
},
{
"id": 41,
"name": "offer",
"description": "Plan de Data para Compartir",
"remainingValue": {
"amount": 24576,
"units": "Mb"
},
"remainingValueName": "Regular",
"validFor": {
"endDateTime": "2023-04-16T23:05:29Z"
},
"@type": "Bucket"
}
]
}
CWC Success Response for /v2:
[
{
"id": "1",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement/v4/BB/bucket/1?logicalResource.id=12462400147",
"isShared": true,
"name": "CORE",
"description": "Core",
"logicalResource": [
{
"@type": "MSISDN",
"id": "12462400147"
}
],
"partyAccount": {
"id": "844"
},
"product": [
{
"id": "24"
}
],
"relatedParty": [
{
"id": "792",
"@referredType": "ServiceInternalId"
}
],
"remainingValue": {
"amount": 7.03,
"units": "BBD"
},
"remainingValueName": "7.03 BBD",
"usageType": "CURRENCY",
"validFor": {
"endDateTime": "2022-12-28T04:00:00.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "Real",
"ratingState": 2,
"@language": "ENG"
},
{
"id": "34",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement/v4/BB/bucket/34?logicalResource.id=12462400147",
"isShared": true,
"name": "VOICE_FLOW",
"description": "Voice_FLOW",
"logicalResource": [
{
"@type": "MSISDN",
"id": "12462400147"
}
],
"partyAccount": {
"id": "844"
},
"product": [
{
"id": "24"
}
],
"relatedParty": [
{
"id": "792",
"@referredType": "ServiceInternalId"
}
],
"remainingValue": {
"amount": 0,
"units": "SECONDS"
},
"remainingValueName": "0 SECONDS",
"usageType": "SECONDS",
"validFor": {
"endDateTime": "2021-12-02T04:00:00.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "Real",
"ratingState": 2,
"@language": "ENG"
}
]
CWC Success Response for /v1:
{
"subscriberNumber": "18765544355",
"balances": [
{
"balanceId": 1,
"balanceValue": 1932.9,
"balanceType": "Currency",
"balanceCategory": "Core",
"balanceName": "primary balance",
"balanceExpiryDate": "2023-03-13T00:00:00-05:00",
"showDate": true,
"showBalance": true
},
{
"balanceId": "appSpotify",
"balanceValue": 9210.05,
"allowanceAmount": 9216,
"balanceType": "data",
"balanceCategory": "data",
"balanceName": "spotify Bal",
"balanceExpiryDate": "2023-04-18T10:16:40-05:00",
"showDate": true,
"showBalance": true
},
{
"balanceId": "2200",
"balanceValue": 0.03,
"allowanceAmount": 0.03,
"balanceType": "MB",
"balanceCategory": "Internet",
"balanceName": "Flow Data",
"balanceExpiryDate": "2023-04-18T10:16:40-05:00",
"showDate": true,
"showBalance": false
},
{
"balanceId": "appTiktok",
"balanceValue": 2600.27,
"allowanceAmount": 4096,
"balanceType": "data",
"balanceCategory": "data",
"balanceName": "tiktok Bal",
"balanceExpiryDate": "2023-04-18T10:16:40-05:00",
"showDate": true,
"showBalance": true
},
{
"balanceId": "appYoutube",
"balanceValue": 17071.15,
"allowanceAmount": 20480,
"balanceType": "data",
"balanceCategory": "data",
"balanceName": "youtube Bal",
"balanceExpiryDate": "2023-04-18T10:16:40-05:00",
"showDate": true,
"showBalance": true
},
{
"balanceId": "appSWIFT",
"balanceValue": 11904.61,
"allowanceAmount": 25600,
"balanceType": "data",
"balanceCategory": "data",
"balanceName": "social media Bal",
"balanceExpiryDate": "2023-04-18T10:16:40-05:00",
"showDate": true,
"showBalance": true
}
]
}